<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Module Contents &mdash; Zapmenot 0.1 documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/sphinx_highlight.js"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Developer" href="developer.html" />
    <link rel="prev" title="Benchmarking" href="benchmarks.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
            <a href="index.html" class="icon icon-home"> Zapmenot
          </a>
              <div class="version">
                0.1
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence &amp; Disclaimer</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="materials.html">Material Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="isotopes.html">Isotope Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="modeling.html">Modeling in ZapMeNot</a></li>
<li class="toctree-l1"><a class="reference internal" href="results.html">Generating Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="graphics.html">We Want Pictures!</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory-and-methods.html">Theory and Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarking</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Module Contents</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-zapmenot.isotope">ZapMeNot Isotope</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.isotope.Isotope"><code class="docutils literal notranslate"><span class="pre">Isotope</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.isotope.Isotope.half_life"><code class="docutils literal notranslate"><span class="pre">Isotope.half_life</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.isotope.Isotope.key_progeny"><code class="docutils literal notranslate"><span class="pre">Isotope.key_progeny</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.isotope.Isotope.name"><code class="docutils literal notranslate"><span class="pre">Isotope.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.isotope.Isotope.photons"><code class="docutils literal notranslate"><span class="pre">Isotope.photons</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-zapmenot.material">ZapMeNot Material</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.material.Material"><code class="docutils literal notranslate"><span class="pre">Material</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.material.Material.density"><code class="docutils literal notranslate"><span class="pre">Material.density</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.material.Material.get_buildup_factor"><code class="docutils literal notranslate"><span class="pre">Material.get_buildup_factor()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.material.Material.get_mass_atten_coeff"><code class="docutils literal notranslate"><span class="pre">Material.get_mass_atten_coeff()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.material.Material.get_mass_energy_abs_coeff"><code class="docutils literal notranslate"><span class="pre">Material.get_mass_energy_abs_coeff()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.material.Material.get_mfp"><code class="docutils literal notranslate"><span class="pre">Material.get_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.material.Material.name"><code class="docutils literal notranslate"><span class="pre">Material.name</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-zapmenot.ray">ZapMeNot Ray</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.ray.FiniteLengthRay"><code class="docutils literal notranslate"><span class="pre">FiniteLengthRay</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.ray.FiniteLengthRay.end"><code class="docutils literal notranslate"><span class="pre">FiniteLengthRay.end</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.ray.FiniteLengthRay.start"><code class="docutils literal notranslate"><span class="pre">FiniteLengthRay.start</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-zapmenot.detector">ZapMeNot Detector</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.detector.Detector"><code class="docutils literal notranslate"><span class="pre">Detector</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.detector.Detector.draw"><code class="docutils literal notranslate"><span class="pre">Detector.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.detector.Detector.location"><code class="docutils literal notranslate"><span class="pre">Detector.location</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-zapmenot.shield">ZapMeNot Shield</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.Box"><code class="docutils literal notranslate"><span class="pre">Box</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.Box.draw"><code class="docutils literal notranslate"><span class="pre">Box.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.Box.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">Box.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.Box.is_infinite"><code class="docutils literal notranslate"><span class="pre">Box.is_infinite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.CappedCylinder"><code class="docutils literal notranslate"><span class="pre">CappedCylinder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.CappedCylinder.draw"><code class="docutils literal notranslate"><span class="pre">CappedCylinder.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.CappedCylinder.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">CappedCylinder.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.CappedCylinder.is_infinite"><code class="docutils literal notranslate"><span class="pre">CappedCylinder.is_infinite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.InfiniteAnnulus"><code class="docutils literal notranslate"><span class="pre">InfiniteAnnulus</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.InfiniteAnnulus.draw"><code class="docutils literal notranslate"><span class="pre">InfiniteAnnulus.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.InfiniteAnnulus.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">InfiniteAnnulus.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.InfiniteAnnulus.is_infinite"><code class="docutils literal notranslate"><span class="pre">InfiniteAnnulus.is_infinite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.SemiInfiniteXSlab"><code class="docutils literal notranslate"><span class="pre">SemiInfiniteXSlab</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.SemiInfiniteXSlab.draw"><code class="docutils literal notranslate"><span class="pre">SemiInfiniteXSlab.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.SemiInfiniteXSlab.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">SemiInfiniteXSlab.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.SemiInfiniteXSlab.is_infinite"><code class="docutils literal notranslate"><span class="pre">SemiInfiniteXSlab.is_infinite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.Shield"><code class="docutils literal notranslate"><span class="pre">Shield</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.Shield.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">Shield.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.Shield.is_infinite"><code class="docutils literal notranslate"><span class="pre">Shield.is_infinite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.XAlignedCylinder"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.XAlignedCylinder.draw"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinder.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.XAlignedCylinder.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinder.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.XAlignedCylinder.is_infinite"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinder.is_infinite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.XAlignedInfiniteAnnulus"><code class="docutils literal notranslate"><span class="pre">XAlignedInfiniteAnnulus</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.XAlignedInfiniteAnnulus.draw"><code class="docutils literal notranslate"><span class="pre">XAlignedInfiniteAnnulus.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.XAlignedInfiniteAnnulus.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">XAlignedInfiniteAnnulus.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.XAlignedInfiniteAnnulus.is_infinite"><code class="docutils literal notranslate"><span class="pre">XAlignedInfiniteAnnulus.is_infinite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.YAlignedCylinder"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.YAlignedCylinder.draw"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinder.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.YAlignedCylinder.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinder.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.YAlignedCylinder.is_infinite"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinder.is_infinite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.YAlignedInfiniteAnnulus"><code class="docutils literal notranslate"><span class="pre">YAlignedInfiniteAnnulus</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.YAlignedInfiniteAnnulus.draw"><code class="docutils literal notranslate"><span class="pre">YAlignedInfiniteAnnulus.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.YAlignedInfiniteAnnulus.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">YAlignedInfiniteAnnulus.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.YAlignedInfiniteAnnulus.is_infinite"><code class="docutils literal notranslate"><span class="pre">YAlignedInfiniteAnnulus.is_infinite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.ZAlignedCylinder"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.ZAlignedCylinder.draw"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinder.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.ZAlignedCylinder.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinder.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.ZAlignedCylinder.is_infinite"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinder.is_infinite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.shield.ZAlignedInfiniteAnnulus"><code class="docutils literal notranslate"><span class="pre">ZAlignedInfiniteAnnulus</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.ZAlignedInfiniteAnnulus.draw"><code class="docutils literal notranslate"><span class="pre">ZAlignedInfiniteAnnulus.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.ZAlignedInfiniteAnnulus.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">ZAlignedInfiniteAnnulus.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.shield.ZAlignedInfiniteAnnulus.is_infinite"><code class="docutils literal notranslate"><span class="pre">ZAlignedInfiniteAnnulus.is_infinite()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-zapmenot.source">ZapMeNot Source</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.source.BoxSource"><code class="docutils literal notranslate"><span class="pre">BoxSource</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.add_isotope_bq"><code class="docutils literal notranslate"><span class="pre">BoxSource.add_isotope_bq()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.add_isotope_curies"><code class="docutils literal notranslate"><span class="pre">BoxSource.add_isotope_curies()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.add_photon"><code class="docutils literal notranslate"><span class="pre">BoxSource.add_photon()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.draw"><code class="docutils literal notranslate"><span class="pre">BoxSource.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">BoxSource.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.get_photon_source_list"><code class="docutils literal notranslate"><span class="pre">BoxSource.get_photon_source_list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.grouping"><code class="docutils literal notranslate"><span class="pre">BoxSource.grouping</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.include_key_progeny"><code class="docutils literal notranslate"><span class="pre">BoxSource.include_key_progeny</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.is_infinite"><code class="docutils literal notranslate"><span class="pre">BoxSource.is_infinite()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.list_discrete_photons"><code class="docutils literal notranslate"><span class="pre">BoxSource.list_discrete_photons()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.list_isotopes"><code class="docutils literal notranslate"><span class="pre">BoxSource.list_isotopes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.BoxSource.points_per_dimension"><code class="docutils literal notranslate"><span class="pre">BoxSource.points_per_dimension</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.source.GroupOption"><code class="docutils literal notranslate"><span class="pre">GroupOption</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.source.LineSource"><code class="docutils literal notranslate"><span class="pre">LineSource</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.add_isotope_bq"><code class="docutils literal notranslate"><span class="pre">LineSource.add_isotope_bq()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.add_isotope_curies"><code class="docutils literal notranslate"><span class="pre">LineSource.add_isotope_curies()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.add_photon"><code class="docutils literal notranslate"><span class="pre">LineSource.add_photon()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.draw"><code class="docutils literal notranslate"><span class="pre">LineSource.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">LineSource.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.get_photon_source_list"><code class="docutils literal notranslate"><span class="pre">LineSource.get_photon_source_list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.grouping"><code class="docutils literal notranslate"><span class="pre">LineSource.grouping</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.include_key_progeny"><code class="docutils literal notranslate"><span class="pre">LineSource.include_key_progeny</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.is_infinite"><code class="docutils literal notranslate"><span class="pre">LineSource.is_infinite()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.list_discrete_photons"><code class="docutils literal notranslate"><span class="pre">LineSource.list_discrete_photons()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.list_isotopes"><code class="docutils literal notranslate"><span class="pre">LineSource.list_isotopes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.LineSource.points_per_dimension"><code class="docutils literal notranslate"><span class="pre">LineSource.points_per_dimension</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.source.PointSource"><code class="docutils literal notranslate"><span class="pre">PointSource</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.add_isotope_bq"><code class="docutils literal notranslate"><span class="pre">PointSource.add_isotope_bq()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.add_isotope_curies"><code class="docutils literal notranslate"><span class="pre">PointSource.add_isotope_curies()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.add_photon"><code class="docutils literal notranslate"><span class="pre">PointSource.add_photon()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.draw"><code class="docutils literal notranslate"><span class="pre">PointSource.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">PointSource.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.get_photon_source_list"><code class="docutils literal notranslate"><span class="pre">PointSource.get_photon_source_list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.grouping"><code class="docutils literal notranslate"><span class="pre">PointSource.grouping</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.include_key_progeny"><code class="docutils literal notranslate"><span class="pre">PointSource.include_key_progeny</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.is_infinite"><code class="docutils literal notranslate"><span class="pre">PointSource.is_infinite()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.list_discrete_photons"><code class="docutils literal notranslate"><span class="pre">PointSource.list_discrete_photons()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.list_isotopes"><code class="docutils literal notranslate"><span class="pre">PointSource.list_isotopes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.PointSource.points_per_dimension"><code class="docutils literal notranslate"><span class="pre">PointSource.points_per_dimension</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.source.Source"><code class="docutils literal notranslate"><span class="pre">Source</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.Source.add_isotope_bq"><code class="docutils literal notranslate"><span class="pre">Source.add_isotope_bq()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.Source.add_isotope_curies"><code class="docutils literal notranslate"><span class="pre">Source.add_isotope_curies()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.Source.add_photon"><code class="docutils literal notranslate"><span class="pre">Source.add_photon()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.Source.get_photon_source_list"><code class="docutils literal notranslate"><span class="pre">Source.get_photon_source_list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.Source.grouping"><code class="docutils literal notranslate"><span class="pre">Source.grouping</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.Source.include_key_progeny"><code class="docutils literal notranslate"><span class="pre">Source.include_key_progeny</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.Source.list_discrete_photons"><code class="docutils literal notranslate"><span class="pre">Source.list_discrete_photons()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.Source.list_isotopes"><code class="docutils literal notranslate"><span class="pre">Source.list_isotopes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.Source.points_per_dimension"><code class="docutils literal notranslate"><span class="pre">Source.points_per_dimension</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.add_isotope_bq"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.add_isotope_bq()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.add_isotope_curies"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.add_isotope_curies()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.add_photon"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.add_photon()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.draw"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.get_photon_source_list"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.get_photon_source_list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.grouping"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.grouping</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.include_key_progeny"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.include_key_progeny</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.is_infinite"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.is_infinite()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.list_discrete_photons"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.list_discrete_photons()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.list_isotopes"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.list_isotopes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.XAlignedCylinderSource.points_per_dimension"><code class="docutils literal notranslate"><span class="pre">XAlignedCylinderSource.points_per_dimension</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.add_isotope_bq"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.add_isotope_bq()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.add_isotope_curies"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.add_isotope_curies()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.add_photon"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.add_photon()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.draw"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.get_photon_source_list"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.get_photon_source_list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.grouping"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.grouping</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.include_key_progeny"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.include_key_progeny</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.is_infinite"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.is_infinite()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.list_discrete_photons"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.list_discrete_photons()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.list_isotopes"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.list_isotopes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.YAlignedCylinderSource.points_per_dimension"><code class="docutils literal notranslate"><span class="pre">YAlignedCylinderSource.points_per_dimension</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.add_isotope_bq"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.add_isotope_bq()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.add_isotope_curies"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.add_isotope_curies()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.add_photon"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.add_photon()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.draw"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.draw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.get_crossing_mfp"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.get_crossing_mfp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.get_photon_source_list"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.get_photon_source_list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.grouping"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.grouping</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.include_key_progeny"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.include_key_progeny</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.is_infinite"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.is_infinite()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.list_discrete_photons"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.list_discrete_photons()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.list_isotopes"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.list_isotopes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.source.ZAlignedCylinderSource.points_per_dimension"><code class="docutils literal notranslate"><span class="pre">ZAlignedCylinderSource.points_per_dimension</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-zapmenot.model">ZapMeNot Model</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#zapmenot.model.Model"><code class="docutils literal notranslate"><span class="pre">Model</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.model.Model.add_detector"><code class="docutils literal notranslate"><span class="pre">Model.add_detector()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.model.Model.add_shield"><code class="docutils literal notranslate"><span class="pre">Model.add_shield()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.model.Model.add_source"><code class="docutils literal notranslate"><span class="pre">Model.add_source()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.model.Model.calculate_exposure"><code class="docutils literal notranslate"><span class="pre">Model.calculate_exposure()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.model.Model.display"><code class="docutils literal notranslate"><span class="pre">Model.display()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.model.Model.generate_summary"><code class="docutils literal notranslate"><span class="pre">Model.generate_summary()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.model.Model.set_buildup_factor_material"><code class="docutils literal notranslate"><span class="pre">Model.set_buildup_factor_material()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#zapmenot.model.Model.set_filler_material"><code class="docutils literal notranslate"><span class="pre">Model.set_filler_material()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developer.html">Developer</a></li>
<li class="toctree-l1"><a class="reference internal" href="version-history.html">Version History</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Zapmenot</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home"></a></li>
      <li class="breadcrumb-item active">Module Contents</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/module-docs.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="module-contents">
<h1>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this heading"></a></h1>
<p>This documentation is a listing of the ZapMeNot classes
that are useful to the shielding practitioner.  Each
class description includes the parameters necessary
to create an object of that class as well as the methods
(i.e. functions) that the class provides.</p>
<p>Note that some classes are based on other ZapMeNot classes.  The base
classes may be selected to show additional methods available
from the base class.  For example. the BoxSource class is
based on both the Source and shield.Box classes.  An instance
of the BoxSource class includes all of the methods available
from the Source
and shield.Box classes.</p>
<section id="module-zapmenot.isotope">
<span id="zapmenot-isotope"></span><h2>ZapMeNot Isotope<a class="headerlink" href="#module-zapmenot.isotope" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.isotope.Isotope">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.isotope.</span></span><span class="sig-name descname"><span class="pre">Isotope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/isotope.html#Isotope"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.isotope.Isotope" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Encapsulates isotope data from the IsotopeLibrary.yml file.</p>
<p>The object is intended to make available the half life and photon
intensities of the requested isotope.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The isotope to be extracted from the isotope library.</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.isotope.Isotope.half_life">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">half_life</span></span><a class="headerlink" href="#zapmenot.isotope.Isotope.half_life" title="Permalink to this definition"></a></dt>
<dd><p>The half life of the isotope in seconds.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.isotope.Isotope.key_progeny">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">key_progeny</span></span><a class="headerlink" href="#zapmenot.isotope.Isotope.key_progeny" title="Permalink to this definition"></a></dt>
<dd><p>The list of progeny that can be in secular or
transient equilibrium.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.isotope.Isotope.name">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#zapmenot.isotope.Isotope.name" title="Permalink to this definition"></a></dt>
<dd><p>The name of the isotope.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.isotope.Isotope.photons">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photons</span></span><a class="headerlink" href="#zapmenot.isotope.Isotope.photons" title="Permalink to this definition"></a></dt>
<dd><p>A list of photon energies (in MeV) and
intensities per decay.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a></p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
<section id="module-zapmenot.material">
<span id="zapmenot-material"></span><h2>ZapMeNot Material<a class="headerlink" href="#module-zapmenot.material" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.material.Material">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.material.</span></span><span class="sig-name descname"><span class="pre">Material</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/material.html#Material"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.material.Material" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Encapsulates the data in the MaterialLibrary.yml file.</p>
<p>Makes available the mean free path, mass
energy absorption coefficient, the mass attenuation coefficient,
and the exposure buildup factor of the requested material.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> – The material to be extracted from the material library</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.material.Material.density">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">density</span></span><a class="headerlink" href="#zapmenot.material.Material.density" title="Permalink to this definition"></a></dt>
<dd><p>The density of the material in g/cm<sup>3</sup></p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.material.Material.get_buildup_factor">
<span class="sig-name descname"><span class="pre">get_buildup_factor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mfps</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">formula</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'GP'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/material.html#Material.get_buildup_factor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.material.Material.get_buildup_factor" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the photon buildup factor at the given energy and mfp</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>) – The photon energy in MeV</p></li>
<li><p><strong>mfps</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>, or <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a>) – One or more mean free path values through the material</p></li>
<li><p><strong>formula</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The format of the buildup factor (only ‘GP’ is currently supported)</p></li>
</ul>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a> – Photon energy is out of range</p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a> – Only GP buildup factors are currently supported</p></li>
</ul>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A vector of photon exposure buildup factors in air, one for
each specified mfp</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a> or <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.material.Material.get_mass_atten_coeff">
<span class="sig-name descname"><span class="pre">get_mass_atten_coeff</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/material.html#Material.get_mass_atten_coeff"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.material.Material.get_mass_atten_coeff" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mass attenuation coefficient at the given energy</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>) – The photon energy in MeV</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a> – Photon energy is out of range</p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The mass attenuation coefficient in cm<sup>2</sup>/g</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.material.Material.get_mass_energy_abs_coeff">
<span class="sig-name descname"><span class="pre">get_mass_energy_abs_coeff</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/material.html#Material.get_mass_energy_abs_coeff"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.material.Material.get_mass_energy_abs_coeff" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mass energy absorption coefficient at the given energy</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>) – The photon energy in MeV</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a> – Photon energy is out of range</p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The mass energy absorption coefficient in cm<sup>2</sup>/g</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.material.Material.get_mfp">
<span class="sig-name descname"><span class="pre">get_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distance</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/material.html#Material.get_mfp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.material.Material.get_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mean free path for a given distance and photon energy</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>) – The photon energy in MeV</p></li>
<li><p><strong>distance</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>) – The distance through the material in cm</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The mean free path in the material</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.material.Material.name">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#zapmenot.material.Material.name" title="Permalink to this definition"></a></dt>
<dd><p>The name of the material</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
<section id="module-zapmenot.ray">
<span id="zapmenot-ray"></span><h2>ZapMeNot Ray<a class="headerlink" href="#module-zapmenot.ray" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.ray.FiniteLengthRay">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.ray.</span></span><span class="sig-name descname"><span class="pre">FiniteLengthRay</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/ray.html#FiniteLengthRay"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.ray.FiniteLengthRay" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Represents a ray in three-space.</p>
<p>The FiniteLengthRay object has a defined starting point, a defined end,
and a resulting direction.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>start</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>) – Defines the starting point of the ray in cartesian coordinates.</p></li>
<li><p><strong>end</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>) – Defines the ending point of the ray in cartesian coordinates.</p></li>
</ul>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.ray.FiniteLengthRay.end">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">end</span></span><a class="headerlink" href="#zapmenot.ray.FiniteLengthRay.end" title="Permalink to this definition"></a></dt>
<dd><p>A list defining the ending point of the ray in
cartesian coordinates.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.ray.FiniteLengthRay.start">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start</span></span><a class="headerlink" href="#zapmenot.ray.FiniteLengthRay.start" title="Permalink to this definition"></a></dt>
<dd><p>A list defining the starting point of the ray in
cartesian coordinates.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a></p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
<section id="module-zapmenot.detector">
<span id="zapmenot-detector"></span><h2>ZapMeNot Detector<a class="headerlink" href="#module-zapmenot.detector" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.detector.Detector">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.detector.</span></span><span class="sig-name descname"><span class="pre">Detector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/detector.html#Detector"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.detector.Detector" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A location used to calculate exposure</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – X coordinate of detector location in cartesian coordinates</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Y coordinate of detector location in cartesian coordinates</p></li>
<li><p><strong>z</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Z coordinate of detector location in cartesian coordinates</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.detector.Detector.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/detector.html#Detector.draw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.detector.Detector.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A degenerate line object representing the detector.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.detector.Detector.location">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">location</span></span><a class="headerlink" href="#zapmenot.detector.Detector.location" title="Permalink to this definition"></a></dt>
<dd><p>The detector location in cartesian coordinates</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
<section id="module-zapmenot.shield">
<span id="zapmenot-shield"></span><h2>ZapMeNot Shield<a class="headerlink" href="#module-zapmenot.shield" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.Box">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">Box</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">box_center</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">box_dimensions</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#Box"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.Box" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.shield.Shield" title="zapmenot.shield.Shield"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shield</span></code></a></p>
<p>A rectangular polyhedron shield.</p>
<p>All sides of the box shield must be axis-aligned.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>box_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the box center.</p></li>
<li><p><strong>box_dimensions</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z dimensions of the box.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.Box.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#Box.draw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.Box.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A box object representing the box shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.Box.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#Box.get_crossing_mfp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.Box.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections with
the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.Box.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#Box.is_infinite"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.Box.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.CappedCylinder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">CappedCylinder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_end</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#CappedCylinder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.CappedCylinder" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.shield.Shield" title="zapmenot.shield.Shield"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shield</span></code></a></p>
<p>A cylindrical shield of finite length</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_start</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the center of one cylinder end.</p></li>
<li><p><strong>cylinder_end</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the center of another cylinder end.</p></li>
<li><p><strong>cylinder_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the cylinder.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.CappedCylinder.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#CappedCylinder.draw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.CappedCylinder.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A cylinder object representing the capped cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.CappedCylinder.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#CappedCylinder.get_crossing_mfp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.CappedCylinder.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.CappedCylinder.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#CappedCylinder.is_infinite"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.CappedCylinder.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.InfiniteAnnulus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">InfiniteAnnulus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_origin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_axis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_inner_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_outer_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#InfiniteAnnulus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.InfiniteAnnulus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.shield.Shield" title="zapmenot.shield.Shield"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shield</span></code></a></p>
<p>An annular shield of infinite length</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_origin</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the point on the cylinder centerline.</p></li>
<li><p><strong>cylinder_axis</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z vector components of the cylinder axis.</p></li>
<li><p><strong>cylinder_inner_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the annulus inner surface.</p></li>
<li><p><strong>cylinder_outer_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the annulus outer surface.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.InfiniteAnnulus.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#InfiniteAnnulus.draw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.InfiniteAnnulus.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A boolean object representing the annular cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.InfiniteAnnulus.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#InfiniteAnnulus.get_crossing_mfp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.InfiniteAnnulus.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.InfiniteAnnulus.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#InfiniteAnnulus.is_infinite"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.InfiniteAnnulus.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.SemiInfiniteXSlab">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">SemiInfiniteXSlab</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_end</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#SemiInfiniteXSlab"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.SemiInfiniteXSlab" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.shield.Shield" title="zapmenot.shield.Shield"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shield</span></code></a></p>
<p>A semi-infinite slab shield perpendicular to the X axis.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>x_start</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – X axis location of the inner edge of the shield.</p></li>
<li><p><strong>x_end</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – X axis location of the outer edge of the shield.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.SemiInfiniteXSlab.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#SemiInfiniteXSlab.draw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.SemiInfiniteXSlab.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A box object representing the slab shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.SemiInfiniteXSlab.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#SemiInfiniteXSlab.get_crossing_mfp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.SemiInfiniteXSlab.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections with
the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.SemiInfiniteXSlab.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#SemiInfiniteXSlab.is_infinite"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.SemiInfiniteXSlab.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.Shield">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">Shield</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#Shield"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.Shield" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></a></p>
<p>Abtract class to model a photon shield.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>, optional) – Shield material type</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3</p></li>
<li><p><strong>**kwargs</strong> – Arbitrary keyword arguments.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.Shield.get_crossing_mfp">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a_ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#Shield.get_crossing_mfp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.Shield.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>a_ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.Shield.is_infinite">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#Shield.is_infinite"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.Shield.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.XAlignedCylinder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">XAlignedCylinder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_center</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#XAlignedCylinder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.XAlignedCylinder" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.shield.CappedCylinder" title="zapmenot.shield.CappedCylinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">CappedCylinder</span></code></a></p>
<p>A cylindrical shield of finite length aligned with the X axis</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the center of the cylinder.</p></li>
<li><p><strong>cylinder_length</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The length of the cylinder.</p></li>
<li><p><strong>cylinder_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the cylinder.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.XAlignedCylinder.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.XAlignedCylinder.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A cylinder object representing the capped cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.XAlignedCylinder.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.XAlignedCylinder.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.XAlignedCylinder.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.XAlignedCylinder.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.XAlignedInfiniteAnnulus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">XAlignedInfiniteAnnulus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_center</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_inner_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_outer_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#XAlignedInfiniteAnnulus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.XAlignedInfiniteAnnulus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.shield.InfiniteAnnulus" title="zapmenot.shield.InfiniteAnnulus"><code class="xref py py-class docutils literal notranslate"><span class="pre">InfiniteAnnulus</span></code></a></p>
<p>An annular shield of infinite length aligned with the X axis</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the point on the cylinder centerline.</p></li>
<li><p><strong>cylinder_inner_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the annulus inner surface.</p></li>
<li><p><strong>cylinder_outer_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the annulus outer surface.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.XAlignedInfiniteAnnulus.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.XAlignedInfiniteAnnulus.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A boolean object representing the annular cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.XAlignedInfiniteAnnulus.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.XAlignedInfiniteAnnulus.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.XAlignedInfiniteAnnulus.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.XAlignedInfiniteAnnulus.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.YAlignedCylinder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">YAlignedCylinder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_center</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#YAlignedCylinder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.YAlignedCylinder" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.shield.CappedCylinder" title="zapmenot.shield.CappedCylinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">CappedCylinder</span></code></a></p>
<p>A cylindrical shield of finite length aligned with the Y axis</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the center of the cylinder.</p></li>
<li><p><strong>cylinder_length</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The length of the cylinder.</p></li>
<li><p><strong>cylinder_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the cylinder.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.YAlignedCylinder.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.YAlignedCylinder.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A cylinder object representing the capped cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.YAlignedCylinder.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.YAlignedCylinder.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.YAlignedCylinder.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.YAlignedCylinder.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.YAlignedInfiniteAnnulus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">YAlignedInfiniteAnnulus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_center</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_inner_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_outer_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#YAlignedInfiniteAnnulus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.YAlignedInfiniteAnnulus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.shield.InfiniteAnnulus" title="zapmenot.shield.InfiniteAnnulus"><code class="xref py py-class docutils literal notranslate"><span class="pre">InfiniteAnnulus</span></code></a></p>
<p>An annular shield of infinite length aligned with the Y axis</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the point on the cylinder centerline.</p></li>
<li><p><strong>cylinder_inner_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the annulus inner surface.</p></li>
<li><p><strong>cylinder_outer_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the annulus outer surface.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.YAlignedInfiniteAnnulus.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.YAlignedInfiniteAnnulus.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A boolean object representing the annular cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.YAlignedInfiniteAnnulus.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.YAlignedInfiniteAnnulus.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.YAlignedInfiniteAnnulus.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.YAlignedInfiniteAnnulus.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.ZAlignedCylinder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">ZAlignedCylinder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_center</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#ZAlignedCylinder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.ZAlignedCylinder" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.shield.CappedCylinder" title="zapmenot.shield.CappedCylinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">CappedCylinder</span></code></a></p>
<p>A cylindrical shield of finite length aligned with the Z axis</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the center of the cylinder.</p></li>
<li><p><strong>cylinder_length</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The length of the cylinder.</p></li>
<li><p><strong>cylinder_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the cylinder.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.ZAlignedCylinder.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.ZAlignedCylinder.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A cylinder object representing the capped cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.ZAlignedCylinder.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.ZAlignedCylinder.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.ZAlignedCylinder.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.ZAlignedCylinder.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.shield.ZAlignedInfiniteAnnulus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.shield.</span></span><span class="sig-name descname"><span class="pre">ZAlignedInfiniteAnnulus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">material_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_center</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_inner_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cylinder_outer_radius</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/shield.html#ZAlignedInfiniteAnnulus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.shield.ZAlignedInfiniteAnnulus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.shield.InfiniteAnnulus" title="zapmenot.shield.InfiniteAnnulus"><code class="xref py py-class docutils literal notranslate"><span class="pre">InfiniteAnnulus</span></code></a></p>
<p>An annular shield of infinite length aligned with the Z axis</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the point on the cylinder centerline.</p></li>
<li><p><strong>cylinder_inner_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the annulus inner surface.</p></li>
<li><p><strong>cylinder_outer_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the annulus outer surface.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.ZAlignedInfiniteAnnulus.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.ZAlignedInfiniteAnnulus.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A boolean object representing the annular cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.ZAlignedInfiniteAnnulus.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.ZAlignedInfiniteAnnulus.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.shield.ZAlignedInfiniteAnnulus.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.shield.ZAlignedInfiniteAnnulus.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

</dd></dl>

</section>
<section id="module-zapmenot.source">
<span id="zapmenot-source"></span><h2>ZapMeNot Source<a class="headerlink" href="#module-zapmenot.source" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.source.</span></span><span class="sig-name descname"><span class="pre">BoxSource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#BoxSource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.BoxSource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.source.Source" title="zapmenot.source.Source"><code class="xref py py-class docutils literal notranslate"><span class="pre">Source</span></code></a>, <a class="reference internal" href="#zapmenot.shield.Box" title="zapmenot.shield.Box"><code class="xref py py-class docutils literal notranslate"><span class="pre">Box</span></code></a></p>
<p>Models a Axis-Aligned rectangular box source</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<a class="reference internal" href="#zapmenot.material.Material" title="zapmenot.material.Material"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.material.Material</span></code></a>) – Shield material type</p></li>
<li><p><strong>box_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the box center.</p></li>
<li><p><strong>box_dimensions</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z dimensions of the box.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.add_isotope_bq">
<span class="sig-name descname"><span class="pre">add_isotope_bq</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">becquerels</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.BoxSource.add_isotope_bq" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in becquerels to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>becquerels</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in becquerels.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.add_isotope_curies">
<span class="sig-name descname"><span class="pre">add_isotope_curies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">curies</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.BoxSource.add_isotope_curies" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in curies to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>curies</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in curies.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.add_photon">
<span class="sig-name descname"><span class="pre">add_photon</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intensity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.BoxSource.add_photon" title="Permalink to this definition"></a></dt>
<dd><p>Adds a photon and intensity to the photon list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV.</p></li>
<li><p><strong>intensity</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The intensity in photons/sec.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.BoxSource.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A box object representing the box shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.BoxSource.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections with
the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.get_photon_source_list">
<span class="sig-name descname"><span class="pre">get_photon_source_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.BoxSource.get_photon_source_list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of photons in the source</p>
<p>This list of photons combines the Isotopes and the
unique_photons specified in the Source definition.
The photon intensities are scaled to <strong>one source point</strong>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in <strong>Bq</strong>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.grouping">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">grouping</span></span><a class="headerlink" href="#zapmenot.source.BoxSource.grouping" title="Permalink to this definition"></a></dt>
<dd><p>State defining the photon energy group
option.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#zapmenot.source.GroupOption" title="zapmenot.source.GroupOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupOption</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.include_key_progeny">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">include_key_progeny</span></span><a class="headerlink" href="#zapmenot.source.BoxSource.include_key_progeny" title="Permalink to this definition"></a></dt>
<dd><p>State defining if key progeny should be included.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.BoxSource.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.list_discrete_photons">
<span class="sig-name descname"><span class="pre">list_discrete_photons</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.BoxSource.list_discrete_photons" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of individual photons in the source.</p>
<p>The list includes only those photons that have been added
individually to the source.  It does not include the photons
that result from the isotopes added to the source.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.list_isotopes">
<span class="sig-name descname"><span class="pre">list_isotopes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.BoxSource.list_isotopes" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of isotopes in the source</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of isotope tuples, each tuple containing a
Isotope object and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.BoxSource.points_per_dimension">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">points_per_dimension</span></span><a class="headerlink" href="#zapmenot.source.BoxSource.points_per_dimension" title="Permalink to this definition"></a></dt>
<dd><p>Number of source points per dimension.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)">list</a> of integers</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.source.GroupOption">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.source.</span></span><span class="sig-name descname"><span class="pre">GroupOption</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#GroupOption"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.GroupOption" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a></p>
<p>Set of possible energy group options.  The options
include ‘group’, ‘discrete’, and ‘hybrid’.</p>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.source.LineSource">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.source.</span></span><span class="sig-name descname"><span class="pre">LineSource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#LineSource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.LineSource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.source.Source" title="zapmenot.source.Source"><code class="xref py py-class docutils literal notranslate"><span class="pre">Source</span></code></a>, <a class="reference internal" href="#zapmenot.shield.Shield" title="zapmenot.shield.Shield"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shield</span></code></a></p>
<p>Models a line radiation source</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>start</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>) – Cartiesian X, Y, and Z coordinates of the starting point of the
line source.</p></li>
<li><p><strong>end</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>) – Cartiesian X, Y, and Z coordinates of the ending point of the
line source.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.add_isotope_bq">
<span class="sig-name descname"><span class="pre">add_isotope_bq</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">becquerels</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.LineSource.add_isotope_bq" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in becquerels to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>becquerels</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in becquerels.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.add_isotope_curies">
<span class="sig-name descname"><span class="pre">add_isotope_curies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">curies</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.LineSource.add_isotope_curies" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in curies to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>curies</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in curies.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.add_photon">
<span class="sig-name descname"><span class="pre">add_photon</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intensity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.LineSource.add_photon" title="Permalink to this definition"></a></dt>
<dd><p>Adds a photon and intensity to the photon list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV.</p></li>
<li><p><strong>intensity</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The intensity in photons/sec.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#LineSource.draw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.LineSource.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A line object representing the line source.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#LineSource.get_crossing_mfp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.LineSource.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<a class="reference internal" href="#zapmenot.ray.FiniteLengthRay" title="zapmenot.ray.FiniteLengthRay"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.ray.FiniteLengthRay</span></code></a>) – The finite length ray that is checked for intersections with
the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Always returns 0</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)">int</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.get_photon_source_list">
<span class="sig-name descname"><span class="pre">get_photon_source_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.LineSource.get_photon_source_list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of photons in the source</p>
<p>This list of photons combines the Isotopes and the
unique_photons specified in the Source definition.
The photon intensities are scaled to <strong>one source point</strong>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in <strong>Bq</strong>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.grouping">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">grouping</span></span><a class="headerlink" href="#zapmenot.source.LineSource.grouping" title="Permalink to this definition"></a></dt>
<dd><p>State defining the photon energy group
option.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#zapmenot.source.GroupOption" title="zapmenot.source.GroupOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupOption</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.include_key_progeny">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">include_key_progeny</span></span><a class="headerlink" href="#zapmenot.source.LineSource.include_key_progeny" title="Permalink to this definition"></a></dt>
<dd><p>State defining if key progeny should be included.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#LineSource.is_infinite"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.LineSource.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.list_discrete_photons">
<span class="sig-name descname"><span class="pre">list_discrete_photons</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.LineSource.list_discrete_photons" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of individual photons in the source.</p>
<p>The list includes only those photons that have been added
individually to the source.  It does not include the photons
that result from the isotopes added to the source.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.list_isotopes">
<span class="sig-name descname"><span class="pre">list_isotopes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.LineSource.list_isotopes" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of isotopes in the source</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of isotope tuples, each tuple containing a
Isotope object and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.LineSource.points_per_dimension">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">points_per_dimension</span></span><a class="headerlink" href="#zapmenot.source.LineSource.points_per_dimension" title="Permalink to this definition"></a></dt>
<dd><p>Number of source points per dimension.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)">list</a> of integers</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.source.PointSource">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.source.</span></span><span class="sig-name descname"><span class="pre">PointSource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#PointSource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.PointSource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.source.Source" title="zapmenot.source.Source"><code class="xref py py-class docutils literal notranslate"><span class="pre">Source</span></code></a>, <a class="reference internal" href="#zapmenot.shield.Shield" title="zapmenot.shield.Shield"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shield</span></code></a></p>
<p>Models a point radiation source</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Cartesian X coordinate of the point source.</p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Cartesian Y coordinate of the point source.</p></li>
<li><p><strong>z</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Cartesian Z coordinate of the point source.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.add_isotope_bq">
<span class="sig-name descname"><span class="pre">add_isotope_bq</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">becquerels</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.PointSource.add_isotope_bq" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in becquerels to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>becquerels</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in becquerels.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.add_isotope_curies">
<span class="sig-name descname"><span class="pre">add_isotope_curies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">curies</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.PointSource.add_isotope_curies" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in curies to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>curies</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in curies.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.add_photon">
<span class="sig-name descname"><span class="pre">add_photon</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intensity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.PointSource.add_photon" title="Permalink to this definition"></a></dt>
<dd><p>Adds a photon and intensity to the photon list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV.</p></li>
<li><p><strong>intensity</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The intensity in photons/sec.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#PointSource.draw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.PointSource.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A degenerate line object representing the point source.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#PointSource.get_crossing_mfp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.PointSource.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<a class="reference internal" href="#zapmenot.ray.FiniteLengthRay" title="zapmenot.ray.FiniteLengthRay"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.ray.FiniteLengthRay</span></code></a>) – The finite length ray that is checked for intersections with
the shield.
Always returns 0 for the Point source.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Always returns 0</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)">int</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.get_photon_source_list">
<span class="sig-name descname"><span class="pre">get_photon_source_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.PointSource.get_photon_source_list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of photons in the source</p>
<p>This list of photons combines the Isotopes and the
unique_photons specified in the Source definition.
The photon intensities are scaled to <strong>one source point</strong>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in <strong>Bq</strong>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.grouping">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">grouping</span></span><a class="headerlink" href="#zapmenot.source.PointSource.grouping" title="Permalink to this definition"></a></dt>
<dd><p>State defining the photon energy group
option.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#zapmenot.source.GroupOption" title="zapmenot.source.GroupOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupOption</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.include_key_progeny">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">include_key_progeny</span></span><a class="headerlink" href="#zapmenot.source.PointSource.include_key_progeny" title="Permalink to this definition"></a></dt>
<dd><p>State defining if key progeny should be included.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#PointSource.is_infinite"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.PointSource.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.list_discrete_photons">
<span class="sig-name descname"><span class="pre">list_discrete_photons</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.PointSource.list_discrete_photons" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of individual photons in the source.</p>
<p>The list includes only those photons that have been added
individually to the source.  It does not include the photons
that result from the isotopes added to the source.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.list_isotopes">
<span class="sig-name descname"><span class="pre">list_isotopes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.PointSource.list_isotopes" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of isotopes in the source</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of isotope tuples, each tuple containing a
Isotope object and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.PointSource.points_per_dimension">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">points_per_dimension</span></span><a class="headerlink" href="#zapmenot.source.PointSource.points_per_dimension" title="Permalink to this definition"></a></dt>
<dd><p>Number of source points per dimension.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)">list</a> of integers</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.source.Source">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.source.</span></span><span class="sig-name descname"><span class="pre">Source</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#Source"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.Source" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></a></p>
<p>Abtract class to model a radiation source.</p>
<p>Maintains a list of isotopes and can return a list of point source
locations within the body of the Source.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>**kwargs</strong> – Arbitrary keyword arguments.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.Source.add_isotope_bq">
<span class="sig-name descname"><span class="pre">add_isotope_bq</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">becquerels</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#Source.add_isotope_bq"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.Source.add_isotope_bq" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in becquerels to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>becquerels</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in becquerels.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.Source.add_isotope_curies">
<span class="sig-name descname"><span class="pre">add_isotope_curies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">curies</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#Source.add_isotope_curies"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.Source.add_isotope_curies" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in curies to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>curies</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in curies.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.Source.add_photon">
<span class="sig-name descname"><span class="pre">add_photon</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intensity</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#Source.add_photon"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.Source.add_photon" title="Permalink to this definition"></a></dt>
<dd><p>Adds a photon and intensity to the photon list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV.</p></li>
<li><p><strong>intensity</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The intensity in photons/sec.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.Source.get_photon_source_list">
<span class="sig-name descname"><span class="pre">get_photon_source_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#Source.get_photon_source_list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.Source.get_photon_source_list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of photons in the source</p>
<p>This list of photons combines the Isotopes and the
unique_photons specified in the Source definition.
The photon intensities are scaled to <strong>one source point</strong>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in <strong>Bq</strong>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.Source.grouping">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">grouping</span></span><a class="headerlink" href="#zapmenot.source.Source.grouping" title="Permalink to this definition"></a></dt>
<dd><p>State defining the photon energy group
option.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#zapmenot.source.GroupOption" title="zapmenot.source.GroupOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupOption</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.Source.include_key_progeny">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">include_key_progeny</span></span><a class="headerlink" href="#zapmenot.source.Source.include_key_progeny" title="Permalink to this definition"></a></dt>
<dd><p>State defining if key progeny should be included.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.Source.list_discrete_photons">
<span class="sig-name descname"><span class="pre">list_discrete_photons</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#Source.list_discrete_photons"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.Source.list_discrete_photons" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of individual photons in the source.</p>
<p>The list includes only those photons that have been added
individually to the source.  It does not include the photons
that result from the isotopes added to the source.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.Source.list_isotopes">
<span class="sig-name descname"><span class="pre">list_isotopes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#Source.list_isotopes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.Source.list_isotopes" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of isotopes in the source</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of isotope tuples, each tuple containing a
Isotope object and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.Source.points_per_dimension">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">points_per_dimension</span></span><a class="headerlink" href="#zapmenot.source.Source.points_per_dimension" title="Permalink to this definition"></a></dt>
<dd><p>Number of source points per dimension.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)">list</a> of integers</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.source.</span></span><span class="sig-name descname"><span class="pre">XAlignedCylinderSource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#XAlignedCylinderSource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.source.Source" title="zapmenot.source.Source"><code class="xref py py-class docutils literal notranslate"><span class="pre">Source</span></code></a>, <a class="reference internal" href="#zapmenot.shield.XAlignedCylinder" title="zapmenot.shield.XAlignedCylinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">XAlignedCylinder</span></code></a></p>
<p>Models a cylindrical source axis-aligned with the X axis.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the center of the cylinder.</p></li>
<li><p><strong>cylinder_length</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The length of the cylinder.</p></li>
<li><p><strong>cylinder_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the cylinder.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.add_isotope_bq">
<span class="sig-name descname"><span class="pre">add_isotope_bq</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">becquerels</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.add_isotope_bq" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in becquerels to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>becquerels</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in becquerels.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.add_isotope_curies">
<span class="sig-name descname"><span class="pre">add_isotope_curies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">curies</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.add_isotope_curies" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in curies to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>curies</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in curies.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.add_photon">
<span class="sig-name descname"><span class="pre">add_photon</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intensity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.add_photon" title="Permalink to this definition"></a></dt>
<dd><p>Adds a photon and intensity to the photon list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV.</p></li>
<li><p><strong>intensity</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The intensity in photons/sec.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A cylinder object representing the capped cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.get_photon_source_list">
<span class="sig-name descname"><span class="pre">get_photon_source_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.get_photon_source_list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of photons in the source</p>
<p>This list of photons combines the Isotopes and the
unique_photons specified in the Source definition.
The photon intensities are scaled to <strong>one source point</strong>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in <strong>Bq</strong>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.grouping">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">grouping</span></span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.grouping" title="Permalink to this definition"></a></dt>
<dd><p>State defining the photon energy group
option.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#zapmenot.source.GroupOption" title="zapmenot.source.GroupOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupOption</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.include_key_progeny">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">include_key_progeny</span></span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.include_key_progeny" title="Permalink to this definition"></a></dt>
<dd><p>State defining if key progeny should be included.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.list_discrete_photons">
<span class="sig-name descname"><span class="pre">list_discrete_photons</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.list_discrete_photons" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of individual photons in the source.</p>
<p>The list includes only those photons that have been added
individually to the source.  It does not include the photons
that result from the isotopes added to the source.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.list_isotopes">
<span class="sig-name descname"><span class="pre">list_isotopes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.list_isotopes" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of isotopes in the source</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of isotope tuples, each tuple containing a
Isotope object and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.XAlignedCylinderSource.points_per_dimension">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">points_per_dimension</span></span><a class="headerlink" href="#zapmenot.source.XAlignedCylinderSource.points_per_dimension" title="Permalink to this definition"></a></dt>
<dd><p>Number of source points per dimension.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)">list</a> of integers</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.source.</span></span><span class="sig-name descname"><span class="pre">YAlignedCylinderSource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#YAlignedCylinderSource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.source.Source" title="zapmenot.source.Source"><code class="xref py py-class docutils literal notranslate"><span class="pre">Source</span></code></a>, <a class="reference internal" href="#zapmenot.shield.YAlignedCylinder" title="zapmenot.shield.YAlignedCylinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">YAlignedCylinder</span></code></a></p>
<p>Models a cylindrical source axis-aligned with the Y axis.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the center of the cylinder.</p></li>
<li><p><strong>cylinder_length</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The length of the cylinder.</p></li>
<li><p><strong>cylinder_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the cylinder.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.add_isotope_bq">
<span class="sig-name descname"><span class="pre">add_isotope_bq</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">becquerels</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.add_isotope_bq" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in becquerels to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>becquerels</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in becquerels.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.add_isotope_curies">
<span class="sig-name descname"><span class="pre">add_isotope_curies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">curies</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.add_isotope_curies" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in curies to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>curies</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in curies.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.add_photon">
<span class="sig-name descname"><span class="pre">add_photon</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intensity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.add_photon" title="Permalink to this definition"></a></dt>
<dd><p>Adds a photon and intensity to the photon list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV.</p></li>
<li><p><strong>intensity</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The intensity in photons/sec.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A cylinder object representing the capped cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.get_photon_source_list">
<span class="sig-name descname"><span class="pre">get_photon_source_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.get_photon_source_list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of photons in the source</p>
<p>This list of photons combines the Isotopes and the
unique_photons specified in the Source definition.
The photon intensities are scaled to <strong>one source point</strong>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in <strong>Bq</strong>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.grouping">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">grouping</span></span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.grouping" title="Permalink to this definition"></a></dt>
<dd><p>State defining the photon energy group
option.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#zapmenot.source.GroupOption" title="zapmenot.source.GroupOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupOption</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.include_key_progeny">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">include_key_progeny</span></span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.include_key_progeny" title="Permalink to this definition"></a></dt>
<dd><p>State defining if key progeny should be included.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.list_discrete_photons">
<span class="sig-name descname"><span class="pre">list_discrete_photons</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.list_discrete_photons" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of individual photons in the source.</p>
<p>The list includes only those photons that have been added
individually to the source.  It does not include the photons
that result from the isotopes added to the source.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.list_isotopes">
<span class="sig-name descname"><span class="pre">list_isotopes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.list_isotopes" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of isotopes in the source</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of isotope tuples, each tuple containing a
Isotope object and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.YAlignedCylinderSource.points_per_dimension">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">points_per_dimension</span></span><a class="headerlink" href="#zapmenot.source.YAlignedCylinderSource.points_per_dimension" title="Permalink to this definition"></a></dt>
<dd><p>Number of source points per dimension.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)">list</a> of integers</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.source.</span></span><span class="sig-name descname"><span class="pre">ZAlignedCylinderSource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/source.html#ZAlignedCylinderSource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#zapmenot.source.Source" title="zapmenot.source.Source"><code class="xref py py-class docutils literal notranslate"><span class="pre">Source</span></code></a>, <a class="reference internal" href="#zapmenot.shield.ZAlignedCylinder" title="zapmenot.shield.ZAlignedCylinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">ZAlignedCylinder</span></code></a></p>
<p>Models a cylindrical source axis-aligned with the Z axis.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>material_name</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">material.Material</span></code>) – Shield material type</p></li>
<li><p><strong>cylinder_center</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – X, Y, and Z coordinates of the center of the cylinder.</p></li>
<li><p><strong>cylinder_length</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The length of the cylinder.</p></li>
<li><p><strong>cylinder_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – Radius of the cylinder.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – Material density in g/cm3.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.add_isotope_bq">
<span class="sig-name descname"><span class="pre">add_isotope_bq</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">becquerels</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.add_isotope_bq" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in becquerels to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>becquerels</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in becquerels.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.add_isotope_curies">
<span class="sig-name descname"><span class="pre">add_isotope_curies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_isotope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">curies</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.add_isotope_curies" title="Permalink to this definition"></a></dt>
<dd><p>Adds an isotope and activity in curies to the isotope list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_isotope</strong> (<a class="reference internal" href="#zapmenot.isotope.Isotope" title="zapmenot.isotope.Isotope"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.isotope.Isotope</span></code></a>) – The isotope to be added to the source.</p></li>
<li><p><strong>curies</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The activity in curies.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.add_photon">
<span class="sig-name descname"><span class="pre">add_photon</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">energy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intensity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.add_photon" title="Permalink to this definition"></a></dt>
<dd><p>Adds a photon and intensity to the photon list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV.</p></li>
<li><p><strong>intensity</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The intensity in photons/sec.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.draw" title="Permalink to this definition"></a></dt>
<dd><p>Creates a display object</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A cylinder object representing the capped cylinder shield.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.pyvista.org/api/core/_autosummary/pyvista.PolyData.html#pyvista.PolyData" title="(in PyVista v0.38.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.PolyData</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.get_crossing_mfp">
<span class="sig-name descname"><span class="pre">get_crossing_mfp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photon_energy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.get_crossing_mfp" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the mfp equivalent if a ray intersects the shield</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ray</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">ray.FiniteLengthRay</span></code>) – The finite length ray that is checked for intersections
with the shield.</p></li>
<li><p><strong>photon_energy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – The photon energy in MeV</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.get_photon_source_list">
<span class="sig-name descname"><span class="pre">get_photon_source_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.get_photon_source_list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of photons in the source</p>
<p>This list of photons combines the Isotopes and the
unique_photons specified in the Source definition.
The photon intensities are scaled to <strong>one source point</strong>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in <strong>Bq</strong>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.grouping">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">grouping</span></span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.grouping" title="Permalink to this definition"></a></dt>
<dd><p>State defining the photon energy group
option.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#zapmenot.source.GroupOption" title="zapmenot.source.GroupOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupOption</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.include_key_progeny">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">include_key_progeny</span></span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.include_key_progeny" title="Permalink to this definition"></a></dt>
<dd><p>State defining if key progeny should be included.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.is_infinite">
<span class="sig-name descname"><span class="pre">is_infinite</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.is_infinite" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if any dimension is infinite, false otherwise</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.list_discrete_photons">
<span class="sig-name descname"><span class="pre">list_discrete_photons</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.list_discrete_photons" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of individual photons in the source.</p>
<p>The list includes only those photons that have been added
individually to the source.  It does not include the photons
that result from the isotopes added to the source.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of photon tuples, each tuple containing a
photon energy in MeV and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.list_isotopes">
<span class="sig-name descname"><span class="pre">list_isotopes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.list_isotopes" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of isotopes in the source</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of isotope tuples, each tuple containing a
Isotope object and an activity in Bq.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="zapmenot.source.ZAlignedCylinderSource.points_per_dimension">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">points_per_dimension</span></span><a class="headerlink" href="#zapmenot.source.ZAlignedCylinderSource.points_per_dimension" title="Permalink to this definition"></a></dt>
<dd><p>Number of source points per dimension.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)">list</a> of integers</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
<section id="module-zapmenot.model">
<span id="zapmenot-model"></span><h2>ZapMeNot Model<a class="headerlink" href="#module-zapmenot.model" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="zapmenot.model.Model">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zapmenot.model.</span></span><span class="sig-name descname"><span class="pre">Model</span></span><a class="reference internal" href="_modules/zapmenot/model.html#Model"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.model.Model" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Performs point-kernel shielding analysis.</p>
<p>The Model class combines various shielding elements to perform
the point-kernel photon shielding analysis.  These elements include
sources, shields, and detectors.</p>
<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.model.Model.add_detector">
<span class="sig-name descname"><span class="pre">add_detector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_detector</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/model.html#Model.add_detector"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.model.Model.add_detector" title="Permalink to this definition"></a></dt>
<dd><p>Set the detector used by the model.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>new_detector</strong> (<a class="reference internal" href="#zapmenot.detector.Detector" title="zapmenot.detector.Detector"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.detector.Detector</span></code></a>) – The detector to be used in the model.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.model.Model.add_shield">
<span class="sig-name descname"><span class="pre">add_shield</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_shield</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/model.html#Model.add_shield"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.model.Model.add_shield" title="Permalink to this definition"></a></dt>
<dd><p>Add a shield to the collection of shields used by the model.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>new_shield</strong> (<a class="reference internal" href="#zapmenot.shield.Shield" title="zapmenot.shield.Shield"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.shield.Shield</span></code></a>) – The shield to be added.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.model.Model.add_source">
<span class="sig-name descname"><span class="pre">add_source</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_source</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/model.html#Model.add_source"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.model.Model.add_source" title="Permalink to this definition"></a></dt>
<dd><p>Set the source used by the model.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>new_source</strong> (<a class="reference internal" href="#zapmenot.source.Source" title="zapmenot.source.Source"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.source.Source</span></code></a>) – The source to be used.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.model.Model.calculate_exposure">
<span class="sig-name descname"><span class="pre">calculate_exposure</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/model.html#Model.calculate_exposure"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.model.Model.calculate_exposure" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the exposure at the detector location.</p>
<p>Note:  Significant use of Numpy arrays to speed up evaluating the
dose from each source point.  A “for loop” is used to loop
through photon energies, but many of the iterations through
all source points is performed using matrix math.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The exposure in units of mR/hr.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)">float</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.model.Model.display">
<span class="sig-name descname"><span class="pre">display</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/model.html#Model.display"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.model.Model.display" title="Permalink to this definition"></a></dt>
<dd><p>Produces a graphic display of the model.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.model.Model.generate_summary">
<span class="sig-name descname"><span class="pre">generate_summary</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/model.html#Model.generate_summary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.model.Model.generate_summary" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the energy flux and exposure at the detector location.</p>
<p>Note:  Significant use of Numpy arrays to speed up evaluating the
dose from each source point.  A “for loop” is used to loop
through photon energies, but many of the iterations through
all source points is performed using matrix math.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List, by photon energy, of photon energy, photon emmission rate,
uncollided energy flux, uncollided exposure, and total exposure</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.model.Model.set_buildup_factor_material">
<span class="sig-name descname"><span class="pre">set_buildup_factor_material</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_material</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/model.html#Model.set_buildup_factor_material"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.model.Model.set_buildup_factor_material" title="Permalink to this definition"></a></dt>
<dd><p>Set the material used to calculation exposure buildup factors.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>new_material</strong> (<a class="reference internal" href="#zapmenot.material.Material" title="zapmenot.material.Material"><code class="xref py py-class docutils literal notranslate"><span class="pre">zapmenot.material.Material</span></code></a>) – The material to be used in buildup factor calculations.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zapmenot.model.Model.set_filler_material">
<span class="sig-name descname"><span class="pre">set_filler_material</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filler_material</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zapmenot/model.html#Model.set_filler_material"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zapmenot.model.Model.set_filler_material" title="Permalink to this definition"></a></dt>
<dd><p>Set the filler material used by the model</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>filler_material</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – The material to be used.</p></li>
<li><p><strong>density</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>, </em><em>optional</em>) – The density of the material in g/cm<sup>3</sup>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="benchmarks.html" class="btn btn-neutral float-left" title="Benchmarking" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="developer.html" class="btn btn-neutral float-right" title="Developer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2019 - 2023, Alan Ford..
      <span class="lastupdated">Last updated on Feb 12, 2023.
      </span></p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>